<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMimePartIter: GMime 3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GMime 3.0 Reference Manual">
<link rel="up" href="MimeParts.html" title="MIME Messages and Parts">
<link rel="prev" href="GMimeMessagePartial.html" title="GMimeMessagePartial">
<link rel="next" href="Parsers.html" title="Parsing Messages and MIME Parts">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gmime-GMimePartIter.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="MimeParts.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GMimeMessagePartial.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Parsers.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gmime-GMimePartIter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gmime-GMimePartIter.top_of_page"></a>GMimePartIter</span></h2>
<p>GMimePartIter — MIME part iterators</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gmime-GMimePartIter.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="returnvalue">GMimePartIter</span></a> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-new" title="g_mime_part_iter_new ()">g_mime_part_iter_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-free" title="g_mime_part_iter_free ()">g_mime_part_iter_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="returnvalue">GMimePartIter</span></a> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-clone" title="g_mime_part_iter_clone ()">g_mime_part_iter_clone</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-reset" title="g_mime_part_iter_reset ()">g_mime_part_iter_reset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-jump-to" title="g_mime_part_iter_jump_to ()">g_mime_part_iter_jump_to</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-is-valid" title="g_mime_part_iter_is_valid ()">g_mime_part_iter_is_valid</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-next" title="g_mime_part_iter_next ()">g_mime_part_iter_next</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-prev" title="g_mime_part_iter_prev ()">g_mime_part_iter_prev</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-get-toplevel" title="g_mime_part_iter_get_toplevel ()">g_mime_part_iter_get_toplevel</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-get-current" title="g_mime_part_iter_get_current ()">g_mime_part_iter_get_current</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-get-parent" title="g_mime_part_iter_get_parent ()">g_mime_part_iter_get_parent</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-get-path" title="g_mime_part_iter_get_path ()">g_mime_part_iter_get_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-replace" title="g_mime_part_iter_replace ()">g_mime_part_iter_replace</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-remove" title="g_mime_part_iter_remove ()">g_mime_part_iter_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gmime-GMimePartIter.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter">GMimePartIter</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gmime-GMimePartIter.description"></a><h2>Description</h2>
<p><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> is an iterator for traversing a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> tree in
Depth-First order.</p>
</div>
<div class="refsect1">
<a name="gmime-GMimePartIter.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="g-mime-part-iter-new"></a><h3>g_mime_part_iter_new ()</h3>
<pre class="programlisting"><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="returnvalue">GMimePartIter</span></a> *
g_mime_part_iter_new (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *toplevel</code></em>);</pre>
<p>Creates a new <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> for iterating over <em class="parameter"><code>toplevel</code></em>
's subparts.</p>
<div class="refsect3">
<a name="g-mime-part-iter-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>toplevel</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> to use as the toplevel</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-new.returns"></a><h4>Returns</h4>
<p> a newly allocated <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> which should be freed
using <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-free" title="g_mime_part_iter_free ()"><code class="function">g_mime_part_iter_free()</code></a> when finished with it.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-free"></a><h3>g_mime_part_iter_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_part_iter_free (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Frees the memory allocated by <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-new" title="g_mime_part_iter_new ()"><code class="function">g_mime_part_iter_new()</code></a>.</p>
<div class="refsect3">
<a name="g-mime-part-iter-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-clone"></a><h3>g_mime_part_iter_clone ()</h3>
<pre class="programlisting"><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="returnvalue">GMimePartIter</span></a> *
g_mime_part_iter_clone (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Clones the <em class="parameter"><code>iter</code></em>
, including its current state.</p>
<div class="refsect3">
<a name="g-mime-part-iter-clone.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-clone.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> that is identical to <em class="parameter"><code>iter</code></em>
. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-reset"></a><h3>g_mime_part_iter_reset ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_part_iter_reset (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Resets the state of <em class="parameter"><code>iter</code></em>
 to its initial state.</p>
<div class="refsect3">
<a name="g-mime-part-iter-reset.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-jump-to"></a><h3>g_mime_part_iter_jump_to ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_part_iter_jump_to (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>,
                          <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre>
<p>Updates the state of <em class="parameter"><code>iter</code></em>
 to point to the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> specified
by <em class="parameter"><code>path</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-part-iter-jump-to.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a string representing the path to jump to</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-jump-to.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> specified by <em class="parameter"><code>path</code></em>
exists or
<code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-is-valid"></a><h3>g_mime_part_iter_is_valid ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_part_iter_is_valid (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Checks that the current state of <em class="parameter"><code>iter</code></em>
 is valid.</p>
<div class="refsect3">
<a name="g-mime-part-iter-is-valid.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-is-valid.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em>
is valid or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-next"></a><h3>g_mime_part_iter_next ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_part_iter_next (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Advances to the next part in the MIME structure used to initialize
<em class="parameter"><code>iter</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-part-iter-next.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-next.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if successful or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-prev"></a><h3>g_mime_part_iter_prev ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_part_iter_prev (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Rewinds to the previous part in the MIME structure used to
initialize <em class="parameter"><code>iter</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-part-iter-prev.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-prev.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if successful or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-get-toplevel"></a><h3>g_mime_part_iter_get_toplevel ()</h3>
<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *
g_mime_part_iter_get_toplevel (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Gets the toplevel <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> used to initialize <em class="parameter"><code>iter</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-part-iter-get-toplevel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-get-toplevel.returns"></a><h4>Returns</h4>
<p>the toplevel <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-get-current"></a><h3>g_mime_part_iter_get_current ()</h3>
<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *
g_mime_part_iter_get_current (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Gets the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> position.</p>
<div class="refsect3">
<a name="g-mime-part-iter-get-current.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-get-current.returns"></a><h4>Returns</h4>
<p>the current <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> or <code class="literal">NULL</code> if the
state of <em class="parameter"><code>iter</code></em>
is invalid. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-get-parent"></a><h3>g_mime_part_iter_get_parent ()</h3>
<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *
g_mime_part_iter_get_parent (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Gets the parent of the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
position.</p>
<div class="refsect3">
<a name="g-mime-part-iter-get-parent.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-get-parent.returns"></a><h4>Returns</h4>
<p>the parent <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> or <code class="literal">NULL</code> if the
state of <em class="parameter"><code>iter</code></em>
is invalid. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-get-path"></a><h3>g_mime_part_iter_get_path ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
g_mime_part_iter_get_path (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Gets the path of the current <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> in the MIME structure
used to initialize <em class="parameter"><code>iter</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-part-iter-get-path.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-get-path.returns"></a><h4>Returns</h4>
<p> a newly allocated string representation of the path to the
<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> position.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-replace"></a><h3>g_mime_part_iter_replace ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_part_iter_replace (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>,
                          <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *replacement</code></em>);</pre>
<p>Replaces the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current position with <em class="parameter"><code>replacement</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-part-iter-replace.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>replacement</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-replace.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the part at the current position was replaced or
<code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-remove"></a><h3>g_mime_part_iter_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_part_iter_remove (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Removes the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current position from its
parent. If successful, <em class="parameter"><code>iter</code></em>
 is advanced to the next position
(since the current position will become invalid).</p>
<div class="refsect3">
<a name="g-mime-part-iter-remove.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-remove.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the part at the current position was removed or
<code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gmime-GMimePartIter.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GMimePartIter"></a><h3>GMimePartIter</h3>
<pre class="programlisting">typedef struct _GMimePartIter GMimePartIter;</pre>
<p>A MIME part iterator.</p>
</div>
</div>
<div class="refsect1">
<a name="gmime-GMimePartIter.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>